chore: custom cargo config to reduce build time #2104
Conversation
hanabi1224
force-pushed
the
cargo-config-speed-up-build
branch
10 times, most recently
from
bb960f5 to
128d3f3
Compare
hanabi1224
force-pushed
the
cargo-config-speed-up-build
branch
from
128d3f3 to
4a2c4c4
Compare
hanabi1224
force-pushed
the
cargo-config-speed-up-build
branch
11 times, most recently
from
3d3548d to
23051c0
Compare
hanabi1224
force-pushed
the
cargo-config-speed-up-build
branch
from
2c6d309 to
89c9597
Compare
hanabi1224
force-pushed
the
cargo-config-speed-up-build
branch
3 times, most recently
from
999a06c to
6cc0ba9
Compare
| - name: Install MDBook | ||
| run: cargo install mdbook mdbook-linkcheck | ||
| continue-on-error: true | ||
| - name: Setup sccache | ||
| uses: hanabi1224/sccache-action@v1.2.0 |
There was a problem hiding this comment.
it would be great to include a comment on why are we using a fork
There was a problem hiding this comment.
Done. Basically we need the cache-update to only save the cache on 1. main branch, 2. cache not found. The original action repo looks like unmaintained so we keep using the fork
| run: make udeps | ||
| - run: make test-all | ||
| env: | ||
| CC: "sccache clang" |
There was a problem hiding this comment.
not sure if it wouldn't clash with some other steps, but would adding those envs as global for the entire workflow be fine?
There was a problem hiding this comment.
sccache is not always the first step to avoid generating cache for cargo install [tools], so that sccache is not available during cargo install and apt-get install which very likely invoke c/c++ compilers
hanabi1224
force-pushed
the
cargo-config-speed-up-build
branch
from
0b0646d to
5dbcbd7
Compare
|
Hey @lemmih I think it requires manual changes to the branch rule of required CI checks before this PR can be merged. Could u help with that? |
Done. |
Summary of changes
Changes introduced in this pull request:
.cargo/config.tomlto improve build performance, for details checkout https://jondot.medium.com/8-steps-for-troubleshooting-your-rust-build-times-2ffc965fd13erust-cachewithsccache-action, also change the cache strategy to write on push tomainbranch only.cargo installed tools (e.g. spellcheck from ~200MB to ~30MB)rust-cache saves >8GB cache on every push to
mainand PR branch, while we only have 10GB total cache size, which makes cache unreliable when github automatically purges themWith the new strategy, PR commit will read the cache generated from the latest
maincommit but not saving them. (github caches are immutable, so saving means duplicating by appending some suffix to the cache key)The cache size each
maincommit saves is now reduced to ~1-2GB.Regarding build time, here is an example run with the new strategy, looks on par or slightly faster than before
The slowest udeps job takes ~15min in previous run, and all-in-one lint job takes ~9min with the new strategy. (They might run on different CPU tho, the hosted runner has a pool of CPU models)
Reference issue to close (if applicable)
Closes
Other information and links